Skip to content

Commit 8dca483

Browse files
sebbader-sapzrgtBirgitBossmjacobyhofermo
authored
V3.1.0 Features (#221)
* Add "\" to avoid ref confusion * Remove unused .emf images * Remove unused images * Remove unused images * Remove unused images * Set descriptive names to images * Fix figure refs in UML doc * Fix figure refs * Fix figure refs between docs * Fix figure refs between docs * change ProtocolInformation/subprotocol from IdShortType to ShortIdType * Fix clause refs where possible Fixed clause refs, where no deeper text adaptation was required * Add metainfo in index.adoc similar to part 1 documentation * Rename puml diagramms acc. to images * Remove "IDTA-01002"-Prefix in filenames The prefix is already included in parent dir name * Set version tag to 'in progress'; remove "DRAFT" in title * Minor change * Add display_version See: https://docs.antora.org/antora/latest/component-display-version/ * Set prerelease to true * Fix name * remove design decision for ReferenceParent and sync the v3.0.2 major changelog section * Adapt changelog to Identifier 2000->2048 + AssetLink (#283) * Adapt changelog to changes of PR #271 Identifier 2000 -> 2048 + AssetLink added as new class * adjust identifiable/id also in openapi files --------- Co-authored-by: Sebastian Bader <s.bader@sap.com> * Apply one-sentence-per-line rule in all docs * Fix small typos * Revert splits in illustration infos * add issue number to changes made for V3.1 * one sentence per line, should fix that there was no space behing ".The * add link: to Part 1 data types * added xref and tags used in xref * Extend the Description of the AssetLink Request (#293) * extend the description of the asset link post * Update DiscoveryServiceSpecification/V3.0_SSP-001.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Integrate PUMLs + small fixes - Add new PUMLs - Small fix of existing PUMLs - Use PUMLs in docs instead of images - Use raw JSON examples in docs instead of images * Small fix * Visual fix * Add idta puml theme * Add pumls for concept images * Make assetKind and assetType optional in the Specification Table (#307) * make assetKind and assetType optional for GetAllAssetAdministrationShellDescriptors * add changelog entry * add link to the github issue * fix typo in the changelog sentence * Remove puml and use original image See #310 (comment) * Add PUMLs for uml annex + adapt texts * add bugfix 3.0.3 changes into the 3.1.0 documents (#322) * Fix type names * Small fix * Add use of pumls to changelog * Update CONTRIBUTING.md "Details of AAS" is deprecated. It is "Specifications of the AAS" (or in short "Specs of AAS" now * Update CONTRIBUTING.md change Details of AAS to Specification of the Asset Administration Shell within Work Group Open Technology * Correct version in changelog (#332) Copy/paste error * Remove footnote about Enterprise Architect * Remove idta theme from puml files We use idta theme in the Antora Configuration repository (aas-specs-antora), so we do not need anymore to define idta theme in PUML files. * add CODEOWNERS * Add details on behavior when query parameters are present multiple times (#336) * add details on behavior when query parameters are present multiple times * update changelog * editorial corrections (#326) * latest version 3.0.3 * added subchapter "History" like in Part 1 updated History (bugfixes not mentioned) added numbers to spec parts * correct note Update service-specifications-and-profiles.adoc: not of SMT Profile was split incorrectly * Use "idShortPath" consistently throughout document * seq-sm-endpoints-http: add /aas/submodels/<submodel-id> fix typos * Fix unresolved xrefs * Fixed `PutAASXPackageById` and `DeleteAASXPackageById` Fixes #352 * Fix xrefs of `SerializationModifier` * Fix small naming error (#353) I believe there was an error made as the Interface mentioned is Repository not the Registry of AAS * Fix Mandatory and Cardinality fields (#359) Findings from hofermo * Update cardinality for Discovery Interface (#356) reported by hofermo * Introduce the IDTA Query Language (#292) Co-authored-by: Sven Walter <waltersven@gmx.de> Co-authored-by: Igor Garmaev <56840636+zrgt@users.noreply.github.com> Co-authored-by: aorzelskiGH <48956800+aorzelskiGH@users.noreply.github.com> Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * remove "submodelElements" from SubmodelValue (#253) * remove "submodelElements" from SubmodelValue * improve language of the valueonly description --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * make assetIds optional for GetAllAssetAdministrationShellIdsByAssetLink (#308) * adding note to explain the desired behavior (#275) * editorial changes (#361) * added xref correct GetDescription to GetSelfDescription renamed id to ID Clause 4.5 substitutet with ref. to AASd-116 * add more xref: * remove deprecated reference to Plattform I4.0 corrected some links do not reference Glossary Plattform I4.0 directly only via Terms and Definitions * added puml to partials, directly link puml, not .png * Adjust OpenAPI Files for Discovery Service Profiles (#229) * add Discovery Service Specification V3.1_SSP-001 as own YAML file * adjust name of Discovery Service Specification SSP-002 * correct links from v3.0.1 to v3.1.0 * Update DiscoveryServiceSpecification/V3.1_SSP-001.yaml --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * complete changelog and editorial changes (#362) * made consistent: no API-operation in interface change table + added missing new operations + renamed query operations (new patterns Query... instead of ByQuery) + added some comments for changes in tables + fix xref name (editorial) * added API-Operations xref to interfaces * reduced columns in change tables + correct formatting errors * fix typo * add [[]] for referencing to chapter ServiceDescription because used * Bug fix missing $ * Change Query and AllAccessRules back to properties Schema changed back Missing $ added * examples for endpoints changed: no OPC examples but two different versions + Catena-X example with DSP + increase 3.0 examples to 3.1 + reformulate and use shall/should etc. * no new interfaces, just new operations for existing interfaces + distinguish between changed and extended * consistency with commas * Add conformance and versioning subchapters conformant to Part 1 (only bib-xref is different) * formatting corrected https metamodel semantic IDs + changes column width (now automatically) + correct formatting in changelog for profiles + formatting cursive for interface names * formatting: added links to Part 1 formatting: added links to Part 2 added labels for referencing [[]] * correct: ServiceSpecificationProfileEnum ist version /3/1 because there are /3/1 profiles in there + added links to figures, tables, chapters (also corrected hard coded one to old .pdf- version) * Update interfaces-payload.adoc - Fix example mapping two different versions of interface on same endpoint - Remove redundant example * correct addresses in endpoint examples * - added tags for referencing - substituted fixed Clause ref with xref * corrected tags for chapters + added json listing formatting to query results * correct link to MultiLanguageNameType + correct hh in table * formatting and correcting (remove + from json code) from Query Results * increase version for classes and operations using types with /3/1 to /3/1 * increase ID for payload class or operation if types used within increased to /3/1 * added links to types + correct data type String to string * formatting * correct xref .(html --> .adoc) * add profiles as new major change in changelog Co-authored-by: Michael Jacoby <michael.jacoby@iosb.fraunhofer.de> * Add source to `interface` term Fixes #340 * Clause 4.5 substituted with ref. to AASd-116 Was partly done in 98a9aea Fixes #305 * Fixes #197 * Fix PutAASXPackageById * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc * marked parameter 'level' as deprecated for all URLs ending with '/' * remove outdated and duplicate file /DiscoveryServiceSpecification/V3.1_SSP-001.yaml * Updated aas-api-versioning-url-scheme images and text Fixes #317 * Fixes #339 * Fixes #117 * Fixes #323 * Revise pagination explanation * issue 220 - fix ServiceDescription as it was already fixed in v3.0.3 * Replace refs to moved chapters with refs to Part 1 Fixes #284 * minor typo * Fix Cardinality for Response Payloads of PUTs and PATCH (#263) * make payload optional for put and patch * Category deprecated, semanticId only ExternalReference * removed Category from example since deprecated * change ConceptDescription to GlobalReference since only external references allowed for semanticId with V3.1 * fix remaining merge conflicts --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> Co-authored-by: Michael Jacoby <michael.jacoby@iosb.fraunhofer.de> * Add the reworked API Versioning chapter (#273) --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Deprecate GetAllAssetAdministrationShellIdsByAssetLink (#376) * Deprecate GetAllAssetAdministrationShellIdsByAssetLink * Deprecate GetAllAssetAdministrationShellIdsByAssetLink in interface definition * Add SearchAllAssetAdministrationShellIdsByAssetLink in interface definition * Added AssetLink class * Update link for AssetLink --------- Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com> * add http mapping entries for bulk endpoints * fix operationIds and x-semanticIds for bulk operations * change automatically generated pattern to real constants + fixing outdated regex pattern for strings (#377) * resolve wrong include for the json query schema * Simplifying Bulk OpenAPI Files (#380) * referencing the part 2 domain classes instead of keeping the whole content * Update SubmodelRegistryServiceSpecification/V3.1_SSP-003.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * fix url where to find the specification --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * editorial changes (#385) * fix formatting * imrpove description * fix formatting * adding missing methods conformant to grammar + removed "SET": seems not to be used (from text and grammar) + SetInvoke does not exist, was probalby Set | Invoke * fix footnote (needs to be footnote:[ instead of footnote[ some formatting * formatting of `$xx` * fix link * move json query schema to partials to test the include statement * test again with old path to not break incoming links * fix antora inclusion error * attempt to fix the last include error * undo include test attempt * fix outdated swagger links * Change ProtocolInformation/securityAttributes from mandatory to optional (#383) * change cardinality of ProtocolInformation/securityAttributes from 1..* to 0..* * add missing references * Update EntireAPI V3.1 plus minor fixes in other OpenAPI Files (#381) * change automatically generated pattern to real constants + fixing outdated regex pattern for strings * referencing the part 2 domain classes instead of keeping the whole content in bulk profiles * use latest content from the aas service full profile * use latest content from the submodel service full profile * use latest content from the aas repository service full profile * add the aas repository query endpoints * use latest content from the submodel repository service full profile * correct minor inconsistencies in the aas repository full profile * fix outdated parts for the submodel repository full profile * add the submodel repository query endpoint * remove incorrect x-semanticId from the aas repo query profile * remove incorrect x-semanticId from the submodel repo query profile and simplify the server examples * remove incorrect x-semanticId from the aas repo query profile * add the conceptdescription repository query endpoints * add the aas registry bulk endpoints * add the aas registry query endpoint * add the submodel registry bulk endpoints * add the submodel registry query endpoint * use latest content from the discovery service full profile * use latest content from the aasx file service full profile * adjusting server examples and api version declarations * rename the entire api file from 3.0 to 3.1 * Update SubmodelRegistryServiceSpecification/V3.1_SSP-003.yaml * remove the attributeItem which is not part of the query language * fix incorrect stringValue fields of the query * fix query endpoint for aas registry * rename all profile files from 3.0 to 3.1 * change publication year for all profiles to 2025 * add changelog entry for new profiles * add change log entry for "servers" in openapi files --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * fix import of the query language overview picture * Fix Regex for modelStringPattern (#386) * fix regex pattern for modelStringPattern * fix condition -> $condition in query examples * Grammar for JSON * Add editorial notes to TOC (#387) This change is required to set line numbers in the generated PDF document from the first page. The code for setting line numbers works based on nav.adoc. It starts with the first dodument referenced in nav.adoc and sets line numbers there. * fix wrong operationId for GetSelfDescription (#388) * use correct operationId, and * use correct x-semanticId * Updated swagger links in http-rest-api.adoc (#389) Links to metamodel and part2 api pointed to v3.1 instead v3.1.0 * editorial changes (#390) * remove Figure, will be automatically added * fix, was redundant add section tag * conformant to other parts: handling of constraints + editorial changes * dotted lines for dependencies formatting enums inherit from enums * formatting, path * formatting * editorial * add: update of interactions diagrams + editorial * subsittuted by " * fix example url in OpenAPI conform to recommendation * change the profile identifiers to /3/1/ * fix reference to wrong clause * Fix unresolved refs * Improve some styling * add cursor and limit query parameters to query endpoints (#393) * correct typo * fix swaggerhub urls and profile identifiers * remove rejected QueryXyzIds profiles * remove rejected QueryXyzIds profiles * remove reference to non-existing API Operation GetAllSubmodelsBySupplementalSemanticId * Update README.md - correct links to releases - add V3.03 release * Correct and UPDATE README.md (#402) * Update README.md - correct links to releases - add V3.0.3 * Update README.md * Split General from Query + update preamble (#403) * split General to General and Query Language update preamble with structure of the document: add links to Query Language and more detailed Annex description * correct links due to split query-language * add "Role" and "NotApplicable" to locations with relation to AssetKind * remove level in metadata operations (#404) * remove note from picture (finding bo-#4) * remove not visible comments from query text * remove the class and enum icons from the query language overview * extend comment about pagination and sorting for queries * fix link for the security demo server * replace se-hierarchy picture with self-drawn, incl. fixed sme-struct * extended description for the "includeConceptDescriptions" parameter * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Extend Interface Values (#415) * add option for value and mateadata interfaces * add option for value and mateadata interfaces * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces-payload.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * add path and metadata to interface parameters --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * clarify PostSubmodelElementByPath behavior (#418) * add notes for base64url Encodings (#416) * add notes to clarify the behavior for base64url encoded values. * improve first note on encoding * Add Qodana to GitHub Actions It will check all changed files on PR * add note for metadata and value-only representations of Asset Administration Shells * removal of chapter Security + editorial changes (#428) * update bilbliography DIN EN IEC 61406-1, now IEC * fix xef to xref * add / update copyright header * correct formatting * Querying now already part of version * add overview of constraints * fix link to figure 1 * cursive for consistency * add Header for Enumeration * fix footnote * fix {} * add xref to modifiers + add subheader for modifiers * typo * add xref and link * remove empty note at the bottom * Content and Metadata start with capital letter * formatting * substitute " + formatting * add link to pagination chapter * add link to chapter serialization modifier * removal of chapter "Security" * close footnote --------- Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com> * Fix typos and add note block * Adjust table entries and text intro * improve text * improve text * Clarify base64url and padding (#425) * explain base64url and padding * add link * Update documentation/IDTA-01002-3/modules/ROOT/pages/http-rest-api/http-rest-api.adoc Co-authored-by: Sebastian Bader <sebastian.r.bader@web.de> --------- Co-authored-by: Michael Jacoby <michael.jacoby@iosb.fraunhofer.de> Co-authored-by: Sebastian Bader <sebastian.r.bader@web.de> * Fix wrong Name of ConceptDescriptionServiceSpecification to ConceptDescriptionRepositoryServiceSpecification (#419) * rename conceptdescriptionservicespecification to conceptdescriptionRrepositoryservicespecification for all in v3.1 * rename conceptdescriptionservicespecification to conceptdescriptionRrepositoryservicespecification for all in v3.1 * bugfix Constraint AASa-004 und editorial changes (#430) * remove security link: chapter was removed * fix link to modifier constraint make consistent Content="xx" and not Content=xxx + Capitalb letter (small letter in http-REST) * bugfix: it is SubmodelRepositoryServiceSpecification/SSP-004 Constraint fixed links added to constraints minor editorial changes * add links to submodel repository service * add links * add links * add content * add links + fix underline * bufix Constraint AASa-003 is also about submodel repository + bufix profile identifier * missing comma --------- Co-authored-by: Sebastian Bader <s.bader@sap.com> * Fix AASQL grammar bugs #433, #434, #435 (#436) * Use partials for bnf Before the bnf grammar was in an .adoc file. In this commit we place it in .bnf file in partials similar as in aas-specs-security repo. * Small fix * Add missing $ for ends-with Fixes #435 * Set brackets mandatory for items in iterables Fixes #433 * Remove redundancy in `stringComparison` --------- Co-authored-by: sebbader-sap <107036549+sebbader-sap@users.noreply.github.com> * Fix Cardinality for Whitespaces in Query Grammar (#437) * Use partials for bnf Before the bnf grammar was in an .adoc file. In this commit we place it in .bnf file in partials similar as in aas-specs-security repo. * Small fix * Add missing $ for ends-with Fixes #435 * Set brackets mandatory for items in iterables Fixes #433 * Remove redundancy in `stringComparison` Fixes #434 * undo changes in stringComparison clause * correct cardinality for whitespaces in the query grammar --------- Co-authored-by: zrgt <garmaev@gmx.de> * Extend Note for PostAllAssetLinksById (#422) * extend note for PostAllAssetLinksById * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * fix for #251 * New AAS Registry Profile "Minimal Read" (SSP-005) (#420) * add new minimal read profile for the ass registry * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * fix typo in operation name * Update AssetAdministrationShellRegistryServiceSpecification/V3.1_SSP-005.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * rename new ssp from registry to asset administration shell registry --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * import updates from https://github.com/admin-shell-io/aas-specs/blob/SeHe/IDTA-01001-3-1_schemas/schemas/json/aas.json (#438) * update readme * [Review] Incorporate Findings affecting OpenAPI (#411) * add comment about the oneOf rendering problem and fixing outdated query result declarations * sync idShort patterns and minLength * add comment about the oneOf rendering problem and fixing outdated query result declarations * Update Part 1 Classes (#413) * incorporate the latest aas json schema changes from part 1 * incorporate valueonly adjustments from part 1 * make the 409 description more generice * make paging_metadata mandatory to match definition in the spec * Update Part2-API-Schemas/openapi.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * Update Part1-MetaModel-Schemas/openapi.yaml Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> --------- Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> * sync aasx file server ssp with swaggerhub * Explain different SSP Versions (#439) * add sentences explaining implicit support of service specification versions * add add sentences explaining implicit support of service specification versions * fix missing '|' in query grammar * Add OperationResultValueOnly and OperationRequestValueOnly Classes (#440) * add OperationResultValueOnly and OperationRequestValueOnly classes * OperationResultValueOnly inherits from BaseOperationResult & using SubmodelElementValue as the data type * extend the explanation how to discover endpoints (#443) * make ProductClassifications an SML as in the latest version of Technical Data (#442) * make consistent to Part 1, Part 3a and Part 5: no navigation to eidtorial notes (#446) * add DOI * Change image and its size * #445: Relaxed api to not throw 404 when element was not found on PUT * Add DOI * add missing api path for PutAssetAdministrationShell * adding missing path to PutAssetAdministrationShell to the changelog * fix anchor for mapping_of_operations section * Fix image * Delete .gitignore As requested * correct url (antora) + editoral changes (#457) * editorial * change url with "antora" * change url to new url (no antora) * #445: Updated interfaces * fix outdated github links (#458) * Correct absolute GitHub links due to renaming of the repos * Revert "Correct absolute GitHub links" This reverts commit 0282740. * Correct absolute GH links due to renaming of the repos * Delete .gitignore * Correct absolute links with new domain * Change Publisher to Copyright (#459) * #445: Introduced 201s, removed "create" for PUT on identifiable services * Update documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc * #445: Introduced 201s, removed "create" for PUT on identifiable services * #445: Editorial - shortened and grammar * add xrefs for all api operations in profiles use latest link for the part 2 http location fix inconsistently used x-semanticIds and operationIds * fix length of subprotocolbody * subprotocolBody has length 2048 according to spec (#460) * subprotocolBody has length 2048 according to spec * update changelog table * Revert "update changelog table" This reverts commit 2800f50. * fix length contenttype from 100 to 128 * fix inconsistency between swagger and text spec by changing LabelType to NameType * sync last changes to patterns coming from the json schema for v3.1 * Add release date under Notice (#462) --------- Co-authored-by: zrgt <garmaev@gmx.de> Co-authored-by: Igor Garmaev <56840636+zrgt@users.noreply.github.com> Co-authored-by: Birgit Boss <59824205+BirgitBoss@users.noreply.github.com> Co-authored-by: Birgit Boss <Birgit.Boss@de.bosch.com> Co-authored-by: Michael Jacoby <michael.jacoby@iosb.fraunhofer.de> Co-authored-by: Moritz Hofer <84278634+hofermo@users.noreply.github.com> Co-authored-by: Sven Walter <waltersven@gmx.de> Co-authored-by: aorzelskiGH <48956800+aorzelskiGH@users.noreply.github.com> Co-authored-by: juileetikekar <99317579+juileetikekar@users.noreply.github.com> Co-authored-by: Alexander Gordt <100141498+alexgordtop@users.noreply.github.com> Co-authored-by: Sebastian Bader <sebastian.r.bader@web.de> Co-authored-by: juileetikekar <juilee.tikekar@idtwin.org> Co-authored-by: Alexander Gordt <alexander.gordt@objective-partner.com>
1 parent f7bb302 commit 8dca483

File tree

118 files changed

+19548
-5881
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+19548
-5881
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Check-changed-files
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened]
6+
7+
permissions:
8+
actions: read
9+
10+
jobs:
11+
qodana:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Fetch Sources
15+
uses: actions/checkout@v4
16+
with:
17+
fetch-depth: ${{ github.event.pull_request.commits }}
18+
19+
- name: Get two more commits so Qodana we can identify the changes
20+
if: github.event_name == 'pull_request'
21+
run: git fetch --deepen=2
22+
23+
- name: Run Qodana inspection
24+
uses: JetBrains/qodana-action@v2024.3.4
25+
with:
26+
upload-result: true
27+
args: >
28+
--baseline,doc/qodana-baseline.sarif.json,
29+
--config,.qodana/qodana.yaml
30+
31+
# This step uploads the SARIF file to GitHub so that the code scanning feature can use it.
32+
# https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github#example-workflow-that-runs-the-eslint-analysis-tool
33+
- name: Upload SARIF report to GitHub
34+
uses: github/codeql-action/upload-sarif@v3
35+
with:
36+
sarif_file: ${{ runner.temp }}/qodana/results/qodana.sarif.json

.qodana/asciidoc-inspection.xml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<component name="InspectionProjectProfileManager">
2+
<profile version="1.0" is_locked="true">
3+
<!-- GrazieInspection normally has a TYPO preference -->
4+
<inspection_tool class="GrazieInspection" enabled="true" level="WARNING" enabled_by_default="true"/>
5+
<inspection_tool class="AsciiDocAnchorWithoutId" enabled="true" level="WARNING" enabled_by_default="true" />
6+
<inspection_tool class="AsciiDocAttributeContinuation" enabled="true" level="WARNING" enabled_by_default="true" />
7+
<inspection_tool class="AsciiDocBlockMacroShouldBeInlineMacro" enabled="true" level="WARNING" enabled_by_default="true" />
8+
<inspection_tool class="AsciiDocDescriptionExists" enabled="true" level="WARNING" enabled_by_default="true" />
9+
<inspection_tool class="AsciiDocDescriptionLength" enabled="true" level="WARNING" enabled_by_default="true" />
10+
<inspection_tool class="AsciiDocHeadingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
11+
<inspection_tool class="AsciiDocHorizontalRule" enabled="true" level="WARNING" enabled_by_default="true" />
12+
<inspection_tool class="AsciiDocInlineMacroShouldBeBlockOrPreprocessorMacro" enabled="true" level="WARNING" enabled_by_default="true" />
13+
<inspection_tool class="AsciiDocLinkResolve" enabled="true" level="ERROR" enabled_by_default="true" />
14+
<inspection_tool class="AsciiDocListingStyle" enabled="true" level="WARNING" enabled_by_default="true" />
15+
<inspection_tool class="AsciiDocPageBreak" enabled="true" level="WARNING" enabled_by_default="true" />
16+
<inspection_tool class="AsciiDocReferencePattern" enabled="true" level="ERROR" enabled_by_default="true" />
17+
<inspection_tool class="AsciiDocXrefWithFileExtension" enabled="true" level="WARNING" enabled_by_default="true" />
18+
<inspection_tool class="AsciiDocXrefWithNaturalCrossReference" enabled="true" level="WARNING" enabled_by_default="true" />
19+
<inspection_tool class="AsciiDocAttributeShouldBeDefined" enabled="true" level="WARNING" enabled_by_default="true" />
20+
<inspection_tool class="AsciiDocObsoletePassthrough" enabled="true" level="WARNING" enabled_by_default="true" />
21+
<inspection_tool class="AsciiDocUnresolvedAntoraModule" enabled="true" level="ERROR" enabled_by_default="true" />
22+
<inspection_tool class="SpellCheckingInspection" enabled="true" level="WARNING" enabled_by_default="true">
23+
<option name="processCode" value="true" />
24+
<option name="processLiterals" value="true" />
25+
<option name="processComments" value="true" />
26+
</inspection_tool>
27+
<inspection_tool class="Style" enabled="true" level="WARNING" enabled_by_default="true" />
28+
</profile>
29+
</component>

.qodana/qodana.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
version: 1.0
2+
profile:
3+
path: .qodana/asciidoc-inspection.xml
4+
linter: jetbrains/qodana-jvm-community:2024.3
5+
plugins:
6+
- id: org.asciidoctor.intellij.asciidoc
7+
8+
include:
9+
- name: HttpUrlsUsage
10+
- name: GrazieInspection
11+
12+
exclude:
13+
- name: All
14+
paths:
15+
- .github
16+
- .qodana
17+
- CONTRIBUTING.md
18+
- LICENSE.txt
19+
- README.md
20+
- AasxFileServerServiceSpecification
21+
- AssetAdministrationShellRegistryServiceSpecification
22+
- AssetAdministrationShellRepositoryServiceSpecification
23+
- AssetAdministrationShellServiceSpecification
24+
- ConceptDescriptionServiceSpecification
25+
- DINSPEC16593-Schemas
26+
- DiscoveryServiceSpecification
27+
- Entire-API-Collection
28+
- Part1-MetaModel-Schemas
29+
- Part2-API-Schemas
30+
- SubmodelRegistryServiceSpecification
31+
- SubmodelRepositoryServiceSpecification
32+
- SubmodelServiceSpecification

AasxFileServerServiceSpecification/V3.0_SSP-001.yaml renamed to AasxFileServerServiceSpecification/V3.1_SSP-001.yaml

Lines changed: 59 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,21 @@ openapi: 3.0.3
22
info:
33
title: DotAAS Part 2 | HTTP/REST | AASX File Server Service Specification
44
description: >-
5-
The File Server Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).
5+
The File Server Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications).
66
7-
Publisher: Industrial Digital Twin Association (IDTA) 2023
7+
Copyright: Industrial Digital Twin Association (IDTA) 2025
88
contact:
99
name: Industrial Digital Twin Association (IDTA)
1010
email: info@idtwin.org
1111
license:
1212
name: CC BY 4.0
1313
url: https://creativecommons.org/licenses/by/4.0/
14-
version: V3.0.4_SSP-001
15-
x-profile-identifier: https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001
16-
termsOfService: https://github.com/admin-shell-io/aas-specs
14+
version: V3.1.0_SSP-001
15+
x-profile-identifier: https://admin-shell.io/aas/API/3/1/AasxFileServerServiceSpecification/SSP-001
16+
termsOfService: https://github.com/admin-shell-io/aas-specs-metamodel
1717
servers:
18-
- url: '{protocol}://{host_name}:{port}/api/{version_prefix}'
19-
variables:
20-
protocol:
21-
description: 'Allows access through http and https (recommended)'
22-
enum:
23-
- 'http'
24-
- 'https'
25-
default: 'https'
26-
host_name:
27-
default: admin-shell.io
28-
description: 'Hostname of server hosting the api'
29-
port:
30-
enum:
31-
- '80'
32-
- '443'
33-
default: '443'
34-
description: '80 is default for http, 443 for https'
35-
version_prefix:
36-
enum:
37-
- 'v3.0'
38-
default: v3.0
18+
- url: 'https://admin-shell.io/api/v3'
19+
- url: 'https://example.com/'
3920
paths:
4021
/packages:
4122
get:
@@ -54,25 +35,25 @@ paths:
5435
explode: true
5536
schema:
5637
type: string
57-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/parameters/Limit'
58-
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/parameters/Cursor'
38+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Limit'
39+
- $ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/parameters/Cursor'
5940
responses:
6041
'200':
6142
description: Requested package list
6243
content:
6344
application/json:
6445
schema:
65-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/schemas/GetPackageDescriptionsResult'
46+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/GetPackageDescriptionsResult'
6647
'400':
67-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
48+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
6849
'401':
69-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/unauthorized'
50+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
7051
'403':
71-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
52+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
7253
'500':
73-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
54+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
7455
default:
75-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
56+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
7657
post:
7758
tags:
7859
- AASX File Server API
@@ -111,19 +92,19 @@ paths:
11192
content:
11293
application/json:
11394
schema:
114-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/schemas/PackageDescription'
95+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PackageDescription'
11596
'400':
116-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
97+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
11798
'401':
118-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/unauthorized'
99+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
119100
'403':
120-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
101+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
121102
'409':
122-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/conflict'
103+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/conflict'
123104
'500':
124-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
105+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
125106
default:
126-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
107+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
127108
/packages/{packageId}:
128109
parameters:
129110
- name: packageId
@@ -155,21 +136,21 @@ paths:
155136
type: string
156137
format: binary
157138
'400':
158-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
139+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
159140
'401':
160-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/unauthorized'
141+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
161142
'403':
162-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
143+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
163144
'404':
164-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/not-found'
145+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
165146
'500':
166-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
147+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
167148
default:
168-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
149+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
169150
put:
170151
tags:
171152
- AASX File Server API
172-
summary: Updates the AASX package at the server
153+
summary: Creates or updates the AASX package at the server
173154
operationId: PutAASXByPackageId
174155
x-semanticIds:
175156
- https://admin-shell.io/aas/API/PutAASXByPackageId/3/0
@@ -194,20 +175,29 @@ paths:
194175
contentType: application/asset-administration-shell-package
195176
required: true
196177
responses:
178+
'201':
179+
description: AASX package stored successfully
180+
headers:
181+
Location:
182+
description: URL of the newly created resource
183+
schema:
184+
type: string
185+
content:
186+
application/json:
187+
schema:
188+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/PackageDescription'
197189
'204':
198190
description: AASX package updated successfully
199191
'400':
200-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
192+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
201193
'401':
202-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/unauthorized'
194+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
203195
'403':
204-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
205-
'404':
206-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/not-found'
196+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
207197
'500':
208-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
198+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
209199
default:
210-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
200+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
211201
delete:
212202
tags:
213203
- AASX File Server API
@@ -219,39 +209,39 @@ paths:
219209
'204':
220210
description: Deleted successfully
221211
'400':
222-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
212+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
223213
'401':
224-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/unauthorized'
214+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/unauthorized'
225215
'403':
226-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
216+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
227217
'404':
228-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/not-found'
218+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
229219
'500':
230-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
220+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
231221
default:
232-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
222+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'
233223
/description:
234224
get:
235225
tags:
236226
- Description API
237227
summary: Returns the self-describing information of a network resource (ServiceDescription)
238-
operationId: GetDescription
228+
operationId: GetSelfDescription
239229
x-semanticIds:
240-
- https://admin-shell.io/aas/API/Descriptor/GetDescription/3/0
230+
- https://admin-shell.io/aas/API/GetSelfDescription/3/1
241231
responses:
242232
'200':
243233
description: Requested Description
244234
content:
245235
application/json:
246236
schema:
247-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/schemas/ServiceDescription'
237+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/schemas/ServiceDescription'
248238
'400':
249-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/bad-request'
239+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/bad-request'
250240
'403':
251-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/forbidden'
241+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/forbidden'
252242
'404':
253-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/not-found'
243+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/not-found'
254244
'500':
255-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/internal-server-error'
245+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/internal-server-error'
256246
default:
257-
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.0.4#/components/responses/default'
247+
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part2-API-Schemas/V3.1.0#/components/responses/default'

0 commit comments

Comments
 (0)