This commit is contained in:
Front
2021-12-27 14:39:54 -05:00
parent 9b8e85742a
commit ffa4173e70
8 changed files with 127 additions and 99 deletions

View File

@@ -31,12 +31,12 @@
export default {
data: () => ({
links: [
{ name: "Home", path: "/"},
{ name: "Install", path: "/install"},
{ name: "FAQ", path: "/faq"},
{ name: "Donate", path: "/donate"},
{ name: "Links", path: "/links"},
{ name: "API", path: "/documentation"},
{ name: "Home", path: "/" },
{ name: "Install", path: "/install" },
{ name: "FAQ", path: "/faq" },
{ name: "Donate", path: "/donate" },
{ name: "Links", path: "/links" },
{ name: "API", path: "/documentation" },
],
}),
};

View File

@@ -28,7 +28,7 @@ export default {
},
env: {
apiUrl: "https://returnyoutubedislikeapi.com"
apiUrl: "https://returnyoutubedislikeapi.com",
},
target: "static",
@@ -56,7 +56,7 @@ export default {
},
},
},
/*
/*
build: {
extend(config, ctx) {
// Run ESLint on save (dev-only)

View File

@@ -1,16 +1,15 @@
<template>
<div>
<!-- Top Section // "Sections" Card -->
<v-card max-width="600px" class="rounded-lg">
<v-card-title style="padding-bottom: 0;">Sections</v-card-title>
<v-card-title style="padding-bottom: 0">Sections</v-card-title>
<v-list>
<!-- Dynamically Generate Links From Below -->
<v-list-item v-for="(item, i) in links" :key="i" router :to=item.to>
<v-list-item v-for="(item, i) in links" :key="i" router :to="item.to">
<v-list-item-icon>
<v-icon v-text="item.icon" />
</v-list-item-icon>
<v-list-item-title style="text-align: left;">
<v-list-item-title style="text-align: left">
<v-list-item-title v-text="item.text" />
</v-list-item-title>
</v-list-item>
@@ -18,42 +17,44 @@
</v-card>
<!-- Child Pages // Card -->
<v-card max-width="600px" class="rounded-lg" style="margin: 1em; padding: 0.75em; text-align: left;">
<v-card
max-width="600px"
class="rounded-lg"
style="margin: 1em; padding: 0.75em; text-align: left"
>
<NuxtChild />
</v-card>
</div>
</template>
<script>
export default {
data() {
return {
//--- Links To Generate Above ---//
links: [{
text: 'Usage Rights',
icon: 'mdi-book-open-variant',
to: '/documentation/usage-rights'
},
{
text: 'URL Information',
icon: 'mdi-web',
to: '/documentation/url'
},
{
text: 'Available Endpoints',
icon: 'mdi-transit-connection-variant',
to: '/documentation/endpoints'
},
{
text: 'Basic Fetching Tutorial',
icon: 'mdi-school',
to: '/documentation/fetching'
},
]
}
}
}
export default {
data() {
return {
//--- Links To Generate Above ---//
links: [
{
text: "Usage Rights",
icon: "mdi-book-open-variant",
to: "/documentation/usage-rights",
},
{
text: "URL Information",
icon: "mdi-web",
to: "/documentation/url",
},
{
text: "Available Endpoints",
icon: "mdi-transit-connection-variant",
to: "/documentation/endpoints",
},
{
text: "Basic Fetching Tutorial",
icon: "mdi-school",
to: "/documentation/fetching",
},
],
};
},
};
</script>

View File

@@ -1,9 +1,8 @@
<template>
<div>
<h1 class="primary--text">Available Endpoints</h1>
List of available endpoints is available here:<br>
<a :href="endpointUrl" v-text="endpointUrl" target="_blank" />
List of available endpoints is available here:<br />
<a :href="endpointUrl" target="_blank" v-text="endpointUrl" />
</div>
</template>
@@ -13,8 +12,8 @@ export default {
data() {
return {
apiUrl: apiUrl,
endpointUrl: apiUrl+'/swagger/index.html'
}
}
}
</script>
endpointUrl: apiUrl + "/swagger/index.html",
};
},
};
</script>

View File

@@ -1,43 +1,61 @@
<template>
<div>
<h1 class="primary--text">Basic Fetching Tutorial</h1>
<span>Example to get votes of a given YouTube video ID:</span>
<a href="https://youtube.com/watch?v=kxOuG8jMIgI" target="_blank">kxOuG8jMIgI</a><br><br>
<a href="https://youtube.com/watch?v=kxOuG8jMIgI" target="_blank"
>kxOuG8jMIgI</a
><br /><br />
<h2>Example Request:</h2>
<span><b>Request URL:</b></span>
<a :href="apiUrl+'/votes?videoId=kxOuG8jMIgI'" v-text="apiUrl+'/votes?videoId=kxOuG8jMIgI'" target="_blank" /><br>
<span><b>Request Method:</b> <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET" target="_blank">HTTP/GET</a></span><br>
<span><b>Headers:</b></span><br>
<a
:href="apiUrl + '/votes?videoId=kxOuG8jMIgI'"
target="_blank"
v-text="apiUrl + '/votes?videoId=kxOuG8jMIgI'"
/><br />
<span
><b>Request Method:</b>
<a
href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/GET"
target="_blank"
>HTTP/GET</a
></span
><br />
<span><b>Headers:</b></span
><br />
<code class="code">
Accept: text/html,application/xhtml+xml,application/xml;q=0.9<br>
Pragma: no-cache<br>
Cache-Control: no-cache<br>
Connection: keep-alive
</code><br>
<span><b>Response:</b></span><br>
<div class="code"><code style="background-color: rgba(0,0,0,0);">
{<br>
"id": "kxOuG8jMIgI",<br>
"dateCreated": "2021-12-20T12:25:54.418014Z",<br>
"likes": 27326,<br>
"dislikes": 498153,<br>
"rating": 1.212014408444885,<br>
"viewCount": 3149885,<br>
"deleted": false<br>
}
</code></div>
<br><br>
Accept: text/html,application/xhtml+xml,application/xml;q=0.9<br />
Pragma: no-cache<br />
Cache-Control: no-cache<br />
Connection: keep-alive </code
><br />
<span><b>Response:</b></span
><br />
<div class="code">
<code style="background-color: rgba(0, 0, 0, 0)">
{<br />
"id": "kxOuG8jMIgI",<br />
"dateCreated": "2021-12-20T12:25:54.418014Z",<br />
"likes": 27326,<br />
"dislikes": 498153,<br />
"rating": 1.212014408444885,<br />
"viewCount": 3149885,<br />
"deleted": false<br />
}
</code>
</div>
<br /><br />
<v-alert border="left" color="orange" text type="info">
<span>An invalid YouTube ID will return status code 404 "Not Found".</span><br>
<span>An incorrectly formatted YouTube ID will return 400 "Bad Request".</span>
<span>An invalid YouTube ID will return status code 404 "Not Found".</span
><br />
<span
>An incorrectly formatted YouTube ID will return 400 "Bad
Request".</span
>
</v-alert>
<a :href="endpointUrl" v-text="endpointUrl" target="_blank" />
<a :href="endpointUrl" target="_blank" v-text="endpointUrl" />
</div>
</template>
@@ -54,7 +72,7 @@ export default {
data() {
return {
apiUrl: process.env.apiUrl,
}
}
}
</script>
};
},
};
</script>

View File

@@ -1,6 +1,8 @@
<template>
<div>
<h1>Welcome to the <span class="primary--text">official RYD docs</span>!</h1>
<h1>
Welcome to the <span class="primary--text">official RYD docs</span>!
</h1>
<p>To get started, select a section.</p>
</div>
</template>

View File

@@ -1,9 +1,8 @@
<template>
<div>
<h1 class="primary--text">URL Information</h1>
The API is accessible over the following base URL:<br>
<a :href="apiUrl" v-text="apiUrl" target="_blank" />
The API is accessible over the following base URL:<br />
<a :href="apiUrl" target="_blank" v-text="apiUrl" />
</div>
</template>
@@ -11,8 +10,8 @@
export default {
data() {
return {
apiUrl: process.env.apiUrl
}
}
}
</script>
apiUrl: process.env.apiUrl,
};
},
};
</script>

View File

@@ -1,12 +1,21 @@
<template>
<div>
<h1 class="primary--text">Usage Rights</h1>
<p>Third party use of this open API is allowed with the following restrictions:</p>
<p>
Third party use of this open API is allowed with the following
restrictions:
</p>
<ul>
<li><b>Attribution:</b> This project should be clearly attributed with either a link to this repo or a link to returnyoutubedislike.com.</li>
<li><b>Rate Limiting:</b> There are per client rate limits in place of 100 per minute and 10'000 per day. This will return a 429 status code indicating that your application should back off.</li>
<li>
<b>Attribution:</b> This project should be clearly attributed with
either a link to this repo or a link to returnyoutubedislike.com.
</li>
<li>
<b>Rate Limiting:</b> There are per client rate limits in place of 100
per minute and 10'000 per day. This will return a 429 status code
indicating that your application should back off.
</li>
</ul>
</div>
</template>
@@ -17,4 +26,4 @@ li {
b {
font-weight: 900 !important;
}
</style>
</style>