mcroissant

.components.securitySchemes={ "ApiKeyAuth" : { "type": "apiKey", "in" : "header", "name" : "X-Gravitee-Api-Key"}} | .paths[]?[]?.security = [{"ApiKeyAuth" : []}]

mcroissant

extends: spectral:oas
rules:
   endpoint-should-be-https:
    description: Endpoints should be using https
    given: $.servers[*]
    severity: error
    then:
      field: url
      function: pattern
      functionOptions:

mcroissant

stages:
  - validate

validate_open-api:
  stage: validate
  image:
    name: stoplight/spectral
    entrypoint: [""]
  script:
    - spectral lint request-apispec.json -f junit -o api-report.xml

mcroissant

...
<build>
    <plugins>
        ...

        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>VERSION HERE</version>
            <configuration>

mcroissant

<?xml version="1.0" encoding="utf-8" ?>
<Feature SiLA2Version="0.1" FeatureVersion="1.0" Originator="org.silastandard" Category="examples"
         xmlns="http://www.sila-standard.org"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://www.sila-standard.org https://gitlab.com/SiLA2/sila_base/raw/master/schema/FeatureDefinition.xsd">
    <Identifier>AutomatedStorage</Identifier>
    <DisplayName>Automated Storage</DisplayName>
    <Description>Feature allowing to interact with automated storage remote controls</Description>

    <DataTypeDefinition>

mcroissant

    <Command>
       ...
        <Parameter>
           ...
            <DataType>
                <DataTypeIdentifier>Rack</DataTypeIdentifier>
            </DataType>
        </Parameter>
        ...
    </Command>

mcroissant

  <DataTypeDefinition>
        <Identifier>Rack</Identifier>
        <DisplayName>Rack</DisplayName>
        <Description>Rack entity containing containers </Description>
        <DataType>
           ...
        </DataType>
  </DataTypeDefinition>

mcroissant

<Feature>
    ...
    <Property>
        <Identifier>FreezerTemperature</Identifier>
        <DisplayName>Freezer Temperature</DisplayName>
        <Description>The current temperature of the freezer</Description>
        <DataType>
            <Basic>Real</Basic>
        </DataType>
        <Observable>Yes</Observable>

mcroissant

    <Command>
        ...
        <Parameter>
            <Identifier>ExpectedRackContent</Identifier>
            <DisplayName>Expected Rack Content</DisplayName>
            <Description>The vials barcode and position which are expected within the rack</Description>
            <DataType>
                <List>
                    <DataType>
                        <Structure>

mcroissant

    <Command>
        ...
        <Parameter>
            <Identifier>RackBarcode</Identifier>
            <DisplayName>Rack Barcode</DisplayName>
            <Description>The barcode of the rack that will be inserted into the automated freezer</Description>
            <DataType>
                <Basic>String</Basic>
            </DataType>
        </Parameter>