Skip to content

Commit 728427a

Browse files
committed
docs: update READMEs
Signed-off-by: Mike Ralphson <mike.ralphson@gmail.com>
1 parent f5db739 commit 728427a

File tree

5 files changed

+14
-203
lines changed

5 files changed

+14
-203
lines changed

API.md

-1
This file was deleted.

CONTRIBUTING.md

+5-74
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ First of all, thank you for considering making a contribution to the project.
77
To add an API to the collection, there must be a machine-readable API description in a format which is or can be converted to OpenAPI (Swagger). These include RAML, API Blueprint, IO Docs, WADL and Google Discovery Format.
88

99
First please check that the API you wish to add isn't already in the collection. You can
10-
browse the APIs in [GitHub](https://github.com/APIs-guru/openapi-directory/tree/master/APIs) or on the [APIs.guru](https://apis.guru/browse-apis/) website.
10+
browse the APIs in [GitHub](https://github.com/APIs-guru/openapi-directory/tree/main/APIs) or on the [APIs.guru](https://apis.guru/) website.
1111

1212
Please also check the API isn't in the process of being added, by checking the [list of open issues](https://github.com/APIs-guru/openapi-directory/issues).
1313

@@ -19,92 +19,23 @@ The API should meet the following criteria:
1919

2020
The easiest way to request an API to be added is to use the [web form](https://apis.guru/add-api/).
2121

22-
### Adding an API via a Pull-Request
23-
24-
Clone the repo locally, if you haven't already done so, and run the following
25-
26-
* run `npm install` to install the dependencies for the utility script
27-
* create a new branch for the PR
28-
* change into the APIs directory
29-
* run `../scripts/collection.js add -c {category} [-l {logo-url}|-t {twitter handle}] {format} {url-to-definition}`
30-
31-
Run `../scripts/collection.js add --help` for a complete list of options.
32-
33-
`{category}` should be one of the values from [/resources/categories.yaml](/resources/categories.yaml), and `{format}` be one of:
34-
35-
* `openapi_3`
36-
* `swagger_2`
37-
* `swagger_1`
38-
* `api_blueprint`
39-
* `raml`
40-
* `io_docs`
41-
* `google`
42-
* `wadl`
43-
44-
If your API definition is unofficial, also specify the `--unofficial` flag.
45-
46-
If there are no validation errors:
47-
48-
* commit your change (including any `patch.yaml` created)
49-
* push your change
50-
* create a Pull Request
51-
5222
## Amending an API definition
5323

5424
### Adding information
5525

56-
If you wish to only add information to the API definition, such as a description, category, logo, tag etc, you can amend the `patch.yaml` file found in the APIs directory. The file is merged with the `swagger.yaml` or `openapi.yaml` file, so the structure should follow that of an OpenAPI definition, including only those properties necessary to place your addition correctly.
57-
58-
For example:
59-
60-
```yaml
61-
info:
62-
description: Our unified API brings together data across all modes of transport into a single RESTful API. This API provides access to the most highly requested realtime and status infomation across all the modes of transport, in a single and consistent way. Access to the developer documentation is available at https://api.tfl.gov.uk
63-
x-logo:
64-
url: 'https://pbs.twimg.com/profile_images/773531056670646272/dsuVeVSg.jpg'
65-
x-apisguru-categories:
66-
- location
67-
- open_data
68-
```
69-
70-
Please issue a Pull Request, it is not necessary to raise an Issue as well.
26+
If you wish to only add information to the API definition, such as a description, category, logo, tag etc, please raise an issue with the relevant details.
7127

7228
### Changing / Fixing an API definition
7329

7430
First please see if you can make your fix upstream with the owner of the API definition, this benefits everyone and is less work than maintaining patches.
7531

7632
Check the `info.contact` section of the API definition or the `x-origin` to see if there is an email or Twitter contact, or a GitHub repository you can contribute to.
7733

78-
#### Do not amend swagger/openapi.yaml files directly
34+
#### Do not raise PRs to amend the openapi/swagger.yaml files directly
7935

8036
If you do this, your changes will be overwritten the next time the API update scripts are run.
8137

82-
The exception to this are APIs.guru-specific specification extensions (aka vendor extensions). Some of these are round-tripped between the modified API definitions on each update.
83-
84-
These extensions are [documented in the Wiki](https://github.com/APIs-guru/openapi-directory/wiki/specification-extensions#apisguru-extensions).
85-
86-
#### Creating a fixup.yaml patch
87-
88-
To do this, you will need to fork the repository and clone your fork locally.
89-
90-
These instructions should work on Linux or other Unix variants, MacOSx and Windows using the Git for Windows shell.
91-
92-
Create a new branch off master using the command:
93-
94-
`git checkout -b {new-branch-name}`
95-
96-
Change into the `APIs` directory.
97-
98-
Ensure your `EDITOR` environment variable is set to a terminal editor such as vi or emacs.
99-
100-
Issue the command `node ../scripts/collection fixup {path/to/swagger.yaml}`
101-
102-
Edit the `swagger.yaml` or `openapi.yaml` file and save.
103-
104-
Issue the command `node ../scripts/collection update {directory-name}` to reprocess the definition from source.
105-
106-
As long as there are no errors...
38+
#### If you want to run our add/update/validate/repair scripts locally
10739

108-
Commit your change with an informative commit message, and push to the new branch on your fork.
40+
Please contact us for details.
10941

110-
Create a Pull Request on GitHub.

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2017 APIs-guru
3+
Copyright (c) 2021 APIs-guru
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

branding/README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
If you're using our catalog to create a product or service we would appreciate if you would spread the word about this project.
1+
If you're using our directory to create a product or service we would appreciate if you would spread the word about this project.
22
It's not mandatory, but definitely helps us to grow bigger and the entire API ecosystem will benefit.
33

4-
Pages which show some info from our catalog could have one of the following links:
4+
Pages which show info from our directory should have one of the following links:
55
- **Powered by \<LOGO\>**
6-
- **API specs supplied by \<LOGO\>**
6+
- **API definitions supplied by \<LOGO\>**
77

8-
All links should point to http://APIs.guru, at the moment it's **temporarily** redirected to GitHub repo.
8+
All links should point to https://APIs.guru.
99

1010
You should use only official logos:
1111

1212
| [Logo]| [Horizontal logo]| [Vertical logo]|
1313
|-------|------------------|----------------|
1414
|![Logo]|![Horizontal logo]|![Vertical logo] |
1515

16-
The correct way to write our name is **APIs.guru** with exact this combination of uppercase and lowercase letters.
17-
We recommended using the [Sansation](http://www.dafont.com/sansation.font) font, or simply use the logo with name included.
16+
The correct way to write our name is **APIs.guru** with exactly this combination of uppercase and lowercase letters.
17+
We recommended using the [Sansation](http://www.dafont.com/sansation.font) font, or simply use the logo with the name included.
1818

19-
If you want to write article or blog post, please use our banner image:
20-
![Banner](https://raw.githubusercontent.com/APIs-guru/openapi-directory/master/branding/banner.svg)
19+
If you want to write an article or blog post, please use our banner image:
20+
![Banner](https://raw.githubusercontent.com/APIs-guru/openapi-directory/main/branding/banner.svg)
2121

2222
### Adding an API to the collection
2323

resources/categories.yaml

-119
This file was deleted.

0 commit comments

Comments
 (0)