git

22 Topics

Support for an OpenAPI spec that is split among multiple files (using $ref)
Originally posted by user x0nifo to the Stoplight Community on 11/10/2022 at 06:44 ET. I'm in the process of evaluating Stoplight as a potential solution for rendering our docs, powered by OpenAPI. Right now, in our repository we have a main openapi.yaml file that however references (via $ref) files that are in different paths inside the same repo. For example, it might do things like $ref: "../../Foo.yml#/components/responses/Bar". We never commit the combined file to the repository. Is that something that the GitHub Stoplight integration supports out of the box? In other words, will we be able to keep using our current structure (i.e. split files) and have Stoplight automatically generate and validate the spec, transparently?
Solved
Stoplight
2 years ago Place Stoplight Questions
416Views
0likes
1Comment
404 error when installing GitHub webhook
Originally posted by user Luca P. to the Stoplight Community on 07/11/2023 at 11:09 ET. Hi all, when I try to install a GitHub webhook for my project, I get an error stating: "Something went wrong while installing this webhook. You may not have the correct GitHub permissions to perform this action in your external VCS." As my permissions should be ok, I checked the raw /graphql API response, and it seems the error is a '404 not found': { "data": null, "errors": [ { "extensions": { "code": "INTERNAL_SERVER_ERROR", "message": "{\"message\":\"Not Found\",\"documentation_url\":\"https://docs.github.com/rest/webhooks/repos#list-repository-webhooks\"}" }, "path": [ "createExternalWebhook" ], "message": "Request failed with status code 404", "locations": [ { "line": 1, "column": 31 } ] } ] }
Solved
Stoplight
2 years ago Place Stoplight Questions
187Views
0likes
1Comment
Receiving error when attempting to connect my stoplight account to git
Originally posted by user aplii to the Stoplight Community on 11/07/2023 at 10:18 ET. I'm currently unable to connect my github account to stoplight. On attempting to connect the account i get the error "This integration account is already associated with 'name@email.com'. I don't have an account for this email address (see screenshot - this is the account it's apparently associated with) and the connection is initially removed from my GitHub apps. Can you help?
Solved
Stoplight
2 years ago Place Stoplight Questions
106Views
0likes
3Comments
How to replicate the export function of Stoplight Desktop from the spectral CLI
Originally posted by user francbartoli to the Stoplight Community on 02/06/2023 at 14:12 ET. I'm trying to bundle a remote schema with the spectral command line in order to get the same result of what I can have if I download the file [https://raw.githubusercontent.com/wmo-im/wcmp2/fix-schema/schemas/wcmpRecordGeoJSON.yaml](https://raw.githubusercontent.com/wmo-im/wcmp2/fix-schema/schemas/wcmpRecordGeoJSON.yaml), open it in Stoplight Desktop and use the Export Dialog. I've tried to run the following spectral command: docker run --rm -it -v $(pwd):/tmp stoplight/spectral lint documents https://raw.githubusercontent.com/wmo-im/wcmp2/fix-schema/schemas/wcmpRecordGeoJSON.yaml -r /tmp/.spectral.yaml -f json -o /tmp/bundled.json -v but it is giving the following error as output: unrecognized-format. Attached the bundled.json output and the link.yaml file referenced in the source that I'm mounting in the volume Is this doable and the right approach? $schema: https://json-schema.org/draft/2020-12/schema $id: https://raw.githubusercontent.com/wmo-im/wcmp2/main/schema/link.yaml title: WCMP 2 link object definition description: WCMP 2 link object definition allOf: - $ref: link.yaml properties: security: type: object $ref: https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.yaml#/definitions/Components/securitySchemes distribution: type: object description: the additional information qualifying the service and allowing to build and display the "access" information in a portal properties: availableFormats: type: array items: type: object properties: name: type: string description: available format short name. description: type: string description: the individual format description to allow building the portal information numberOFiles: type: string description: typical number of files disseminated by the distribution mechanism over a period of time typicalFilesize: type: string description: size of a typical individual file (e.g. KB, MB, GB) typicalFilename: type: string description: example filename samples: type: object description: links of samples that can be openly accessed by users to provide a better understanding of the data items: type: object $ref: https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/schemas/common/link.yaml documentation: type: array description: links to the associated documentation available for this format when applicable items: type: object $ref: https://raw.githubusercontent.com/opengeospatial/ogcapi-records/master/core/openapi/schemas/common/link.yaml channel: type: string description: topic to subscribe to for broker workflow [ { "code": "unrecognized-format", "path": [], "message": "The provided document does not match any of the registered formats [OpenAPI 2.0 (Swagger), OpenAPI 3.x, OpenAPI 3.0.x, OpenAPI 3.1.x, AsyncAPI 2.0.x, AsyncAPI 2.1.x, AsyncAPI 2.2.x, AsyncAPI 2.3.x, AsyncAPI 2.4.x, AsyncAPI 2.5.x]", "severity": 1, "range": { "start": { "line": 0, "character": 0 }, "end": { "line": 94, "character": 21 } }, "source": "https://raw.githubusercontent.com/wmo-im/wcmp2/fix-schema/schemas/wcmpRecordGeoJSON.yaml" } ]
Stoplight
2 years ago Place Stoplight Questions
94Views
0likes
0Comments
Stoplight just deleted all my GitHub projects. Now it's refusing to let me connect to GitHub. Help?
Originally posted by user Nananana to the Stoplight Community on 01/09/2024 at 07:46 ET. Have created a ticket on the Support Portal but no idea when I'll hear back, and this is pretty urgent. Would appreciate anyone's advice with this. I changed the GitHub integration settings in our workspace. This deleted all projects we had which were linked to GitHub. This was not desired and there was no warning. Since these projects were backed by GitHub, I assumed I could get them back by re-creating projects from the GitHub repositories. However, Stoplight is throwing errors when I try to do this. I set up a new GitHub Integration in Settings, using a GitHub OAuth App, as instructed in the docs. The Test Settings button tells me that Everything Looks Good!. However when I go to "Create or Import a Project - Add from GitHub", it tells me I need to Connect GitHub. I had assumed that the GitHub integration would handle this automatically, but it doesn't seem to. I continued to authorize the connection with GitHub. However this returns an error message: "syntax error at or near \")\"". I have retried multiple times, but Stoplight refuses to connect my GitHub account. This means I have not been able to recreate our GitHub-backed Stoplight projects. So basically all our production API docs are down, as I'm trying to onboard a new client to said API. Any advice?
Solved
Stoplight
2 years ago Place Stoplight Questions
87Views
0likes
2Comments
Forced upgrade breaks my project
Originally posted by user bobdobbs to the Stoplight Community on 01/30/2023 at 02:47 ET. I've been happily using the open source version of stoplight studio with local files Client requirements, and security rules prevent me from putting the API information into the could. The previous version of stoplight let me work with a local directory, and was awesome! Now, I need to login, and it looks like stoplight is uploading all the information/yaml to its own servers. That breaks everything for me. I looked to download an earlier version from github, but: The earlier releases have been removed form github The nightly builds will AUTO-UPDATE without any choice, and then require the cloud version How can I just run the older version and work with my local files???
Solved
Stoplight
2 years ago Place Stoplight Questions
83Views
0likes
1Comment
Split a GitHub repo to different Stoplight project
Originally posted by user ckjeter to the Stoplight Community on 06/29/2023 at 04:03 ET. I have multiple components with different OpenAI yaml files in a single GitHub repo. Wondering is there any approach to separate them in different Stoplight project or import specific folder when creating stoplight project? If GitHub integration function can’t achieve this, can CLI mode do the trick? Thanks the community!
Solved
Stoplight
2 years ago Place Stoplight Questions
57Views
0likes
1Comment
Where are masks stored in a git repo?
Originally posted by user MariusSc78 to the Stoplight Community on 01/05/2024 at 03:23 ET. I have created a mask of my address model and published it to my github repo. After that I have changed some properties in that new masks I have created. Now, I am wondering where the mask (and the changes) is located/stored in the git repo. I only saw that a resolutions.json has been created that includes an id reference. But the actual change/mask I do not find. I don't use component library project. I am using the model folder in my api project. I think it is called local models. According to my findings, I don't think that masks are stored in git, rather than somewhere within the stoplight platform. Am I correct?
Solved
Stoplight
2 years ago Place Stoplight Questions
55Views
0likes
2Comments
Revert to previous git commit
Originally posted by user Alucryd to the Stoplight Community on 02/29/2024 at 08:50 ET. Hi all, we unfortunately made a mistake and wiped out a whole api definition, is there any way to revert our files to a previous commit on the basic plan? Couldn't find any way to view or edit the git history.
Stoplight
2 years ago Place Stoplight Questions
45Views
1like
1Comment
Where can I find the Stoplight API V1 documentation?
Originally posted by user Jakuarella to the Stoplight Community on 11/15/2022 at 10:26 ET. I am able to get the toc.json file using the Stoplight API using the following endpoint: https://stoplight.io/api/v1/projects/xxxxxxxxxxxxx/table-of-contents. I want to get the same file but from a branch. Is this possible? Is there any API documentation around this?
Solved
Stoplight
2 years ago Place Stoplight Questions
44Views
0likes
4Comments