-
Notifications
You must be signed in to change notification settings - Fork 24
/
jeopardy.yml
87 lines (59 loc) · 4.03 KB
/
jeopardy.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
list:
- answer: An authorization method for API requests that uses a third-party identity server such as Google, GitHub, or Facebook.
question: What is oAuth?
- answer: A tool you can use to submit API requests directly from the command line.
question: What is curl?
- answer: A GUI tool that lets you save and organize API requests into collections.
question: What is Postman?
- answer: A format that includes both objects and arrays, and often a mix of both.
question: What is JSON?
- answer: A space-sensitive format that is commonly used to write the OpenAPI specification.
question: What is YAML?
- answer: The four most common methods or operations used with API requests.
question: What are GET, POST, PUT, and DELETE?
- answer: The five common sections every API reference topic usually has.
question: What are resource description, endpoints & methods, parameters, request example, and response example & schema?
- answer: A description of all possible elements in a response, including their data types and other details.
question: What is a response schema?
- answer: The object within the OpenAPI specification that lets you store re-usable content that can be referenced in other parts of the specification document using <code>$ref</code>.
question: What is the <code>components</code> object?
- answer: The original name of the OpenAPI specification.
question: What is Swagger?
- answer: An authoring and validation tool useful when creating OpenAPI specification files.
question: What is Swagger Editor?
- answer: A design model where you create the OpenAPI specification first before beginning any coding.
question: What is a spec-first philosophy?
- answer: Information about request thresholds and what happens when you exceed them.
question: What is rate limiting?
- answer: An open-source web framework that renders OpenAPI specification documents into an interactive documentation experience.
question: What is Swagger UI?
- answer: Authoring and publishing tools/workflows that follow similar patterns as software development tools and workflows.
question: What are docs-as-code tools?
- answer: A request to merge a branch back into the master; this workflow is often used when merging contributions back in to GitHub projects.
question: What is a pull request?
- answer: The tendency for docs maintained outside of code repositories to become out of sync with the code.
question: What is documentation drift?
- answer: An essential first steps document for users that should usually be linked from your product overview page.
question: What is Getting Started?
- answer: The go-to place to find open-source projects and collaborate with others on code projects.
question: What is GitHub?
- answer: A number shown in an API response when a request either succeeds or fails.
question: What are status and error codes?
- answer: A parameter that appears in the resource URL after a question mark.
question: What is a query string parameter?
- answer: A string often included in a header or query string parameter that authorizes the API request.
question: What is an API key?
- answer: The premium version of Swagger Editor.
question: What is SwaggerHub?
- answer: A GUI tool for designing OpenAPI specification files, including the ability to auto-generate the schema description for JSON.
question: What is Stoplight?
- answer: Programmatically building documentation from the server when you commit to a particular Git branch.
question: What is continuous deployment?
- answer: A web service API format, based on XML, that was popular before REST took over the landscape.
question: What is SOAP?
- answer: A type of API that consists of libraries or other code that you download and incorporate directly into your project.
question: What is a native library API?
- answer: Tooling that supports the implemention of an API in a specific programming language.
question: What is an SDK?
- answer: A parameter that appears directly in the resource URL (before any query strings).
question: What is a header parameter?