AdobeDocs / AdobeDocs/pdfservices-api-documentation

OpenApi error in Swagger

Open
#1,026 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
20
Forks
229
PR merge metrics
No merged PRs in 30d

Description

I'm trying to create an SDK from [Swagger](https://editor.swagger.io/).

I got this error:

```
Semantic error at paths./assets/{assetId}
Declared path parameter "assetId" needs to be defined as a path parameter at either the path or operation level
Jump to line 309
Semantic error at paths./assets/{assetId}/metadata
Declared path parameter "assetId" needs to be defined as a path parameter at either the path or operation level
Jump to line 496
Semantic error at components.schemas.PageManipulationInternal.properties.pageActions.items
`items` must be an object
Jump to line 7298
Structural error at components.schemas.PageManipulationInternal.properties.pageActions.items
should be object
Jump to line 7298
Semantic error at components.schemas.PageManipulationExternal.properties.params.properties.pageActions.items
`items` must be an object
Jump to line 7343
Structural error at components.schemas.PageManipulationExternal.properties.params.properties.pageActions.items
should be object
Jump to line 7343
Structural error at components.schemas.responseAsset.properties.assetID.required
should be an array of property names required within an object schema
Jump to line 9096
Structural error at components.schemas.responseAssetZip.properties.assetID.required
should be an array of property names required within an object schema
Jump to line 9126
Semantic error at components.schemas.doneWithMultipleAsset.properties.assetList.items
`items` must be an object
Jump to line 9152
Structural error at components.schemas.doneWithMultipleAsset.properties.assetList.items
should be object
Jump to line 9152
Semantic error at components.schemas.ExtractPDFDone.oneOf.1.$ref
$refs must reference a valid location in the document
Jump to line 9617
```

Contributor guide

Open the contributing guide

Research direction

Open the API definition in Swagger Editor and inspect paths./assets/{assetId}, paths./assets/{assetId}/metadata, and the schemas at the reported line numbers. Check the path parameters, items, required arrays, and ExtractPDFDone.oneOf.1.$ref against OpenAPI validation, then confirm the document validates and SDK generation proceeds without these errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.